Properties

Name Returns Notes Example
title String Returns the title (ie, as in the page title) of the resource. This is the nickname if available, otherwise the first name, otherwise the resource name, which is also the user ID
repositories List Get the repositories owned by this user
children ResourceList
name String
createDate Date The date this profile was created
modifiedDate Date
parent CommonCollectionResource
idenitifer PrincipleId The identifier is the same as the path to the user
calendarHomeSet HrefList Contains a single path, which is the path to this users collection of calendars
calendarUserAddressSet HrefList
addressBookHomeSet HrefList
address String
accessControlList Map Get all allowed priviledges for all principals on this resource. Note that a principal might be a user, a group, or a built-in webdav group such as AUTHENTICATED
thisUser Profile Get the user this resource represents
inbox MessageFolder A folder containing received messages
nickName String The name the user was asked to be identified as. Note there is no uniqueness constraints on this field
userId Long The numeric ID of this user. Always unique
thisProfile Profile
supportedComponentSets SupportedCalendarComponentListsSet
primaryMembership MembershipBean Get the first membership for the primary group this user is associated with. Return null if there are none.
primaryMemberships MembershipList Get all primary memberships as a list
memberships MembershipList Get all memberships for organisations within the current organisation
calendarUserType String
profile ProfileBean
extProfileBean ExtProfileBean
currentUserRoles Set Get all current roles for a user
allFields Map Returns a map of all fields stored against this profile for all groups in this organisation, keyed on the field name. If there are fields with the same name only one will be in the map
surName String The user's surname
firstName String The user's first name
email String
profilePicHref String
lastVisit Date
signatureCredentials Map
phone String The standard phone number field for a profile
directoryTemplate String
activeMenuIds String

Methods

Name Returns Notes Example
isInGroup ( groupName ) boolean Check if the user has a membershuip in the organisation currently being accessed, or a child of it, to a group of the given name
isInGroup ( groupName, orgId ) boolean Check if the user has a membershuip in the group, for the given organisation
memberships ( groupName ) MembershipList
dailyVisits ( from, to ) List Get the number of hits for each day with visits for this user and website, in the given date range
dailyVisits ( website ) List
save ( ) void Apply any changes to persistence. Does not use a transaction, so you must have started a transaction already. This will update the search index so should be done last to ensure the transaction is not rolled back
Hide comments

Ask a question, or offer an answer